home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1542.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  4.5 KB  |  187 lines
  1. 133
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. XCopyProgress 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baXCopyProgress copies multiple files, including sub-folders, while displaying a 
  20. --- RECORDSEPARATOR ---
  21. progress dialog
  22. --- RECORDSEPARATOR ---
  23.  
  24. --- RECORDSEPARATOR ---
  25. Usage:
  26. --- RECORDSEPARATOR ---
  27.  
  28. --- RECORDSEPARATOR ---
  29. Result = baXCopyProgress( SourceDir, DestDir, FileSpec, Overwrite, MakeDir, 
  30. --- RECORDSEPARATOR ---
  31. Title, ButtonText, Flags )
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. Arguments:
  36. --- RECORDSEPARATOR ---
  37.  
  38. --- RECORDSEPARATOR ---
  39. String, string, string, string, integer, string, string, integer. 
  40. --- RECORDSEPARATOR ---
  41. SourceDir is the folder to copy from. 
  42. --- RECORDSEPARATOR ---
  43. DestDir is the folder to copy to. 
  44. --- RECORDSEPARATOR ---
  45. FileSpec determines what files are copied. 
  46. --- RECORDSEPARATOR ---
  47. Overwrite determines how the copy is done. Can be: 
  48. --- RECORDSEPARATOR ---
  49. "Always" 
  50. --- RECORDSEPARATOR ---
  51. always copies the file 
  52. --- RECORDSEPARATOR ---
  53. "IfNewer" 
  54. --- RECORDSEPARATOR ---
  55. copies the file if SourceFile is newer than DestFile 
  56. --- RECORDSEPARATOR ---
  57. "IfNotExist" 
  58. --- RECORDSEPARATOR ---
  59. copies only if DestFile does not already exist 
  60. --- RECORDSEPARATOR ---
  61. If MakeDir is true, any empty directories will be created. 
  62. --- RECORDSEPARATOR ---
  63. Title is the title of the dialog box. 
  64. --- RECORDSEPARATOR ---
  65. ButtonText is the text to use in the Cancel button. 
  66. --- RECORDSEPARATOR ---
  67. Flags changes the behaviour of the dialog, see notes for details.
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. Returns:
  72. --- RECORDSEPARATOR ---
  73.  
  74. --- RECORDSEPARATOR ---
  75. Integer. 
  76. --- RECORDSEPARATOR ---
  77. Returns 0 if the file was copied successfully, otherwise one of these: 
  78. --- RECORDSEPARATOR ---
  79. 1 
  80. --- RECORDSEPARATOR ---
  81. Invalid Source file name 
  82. --- RECORDSEPARATOR ---
  83. 2 
  84. --- RECORDSEPARATOR ---
  85. Invalid Dest file name 
  86. --- RECORDSEPARATOR ---
  87. 3 
  88. --- RECORDSEPARATOR ---
  89. Error reading the Source 
  90. --- RECORDSEPARATOR ---
  91. file 
  92. --- RECORDSEPARATOR ---
  93. 4 
  94. --- RECORDSEPARATOR ---
  95. Error writing the Dest file 
  96. --- RECORDSEPARATOR ---
  97. 5 
  98. --- RECORDSEPARATOR ---
  99. Couldn't create directory for Dest file 
  100. --- RECORDSEPARATOR ---
  101. 6 
  102. --- RECORDSEPARATOR ---
  103. Dest file exists 
  104. --- RECORDSEPARATOR ---
  105. 7 
  106. --- RECORDSEPARATOR ---
  107. Dest file is newer that Source file 
  108. --- RECORDSEPARATOR ---
  109. 8 
  110. --- RECORDSEPARATOR ---
  111. No files matched the specified type 
  112. --- RECORDSEPARATOR ---
  113. 9 
  114. --- RECORDSEPARATOR ---
  115. User cancelled the copy
  116. --- RECORDSEPARATOR ---
  117.  
  118. --- RECORDSEPARATOR ---
  119. Examples:
  120. --- RECORDSEPARATOR ---
  121.  
  122. --- RECORDSEPARATOR ---
  123. Director: 
  124. --- RECORDSEPARATOR ---
  125. OK = baXCopyProgress( "c:\data" , "d:\backup" , "*.dat", "IfNewer", true, "Backing 
  126. --- RECORDSEPARATOR ---
  127. up files... ", "Cancel", 0 ) 
  128. --- RECORDSEPARATOR ---
  129. Authorware: 
  130. --- RECORDSEPARATOR ---
  131. OK := baXCopyProgress( "c:\\data" , "d:\\backup" , "*.dat", "IfNewer" , true, 
  132. --- RECORDSEPARATOR ---
  133. "Backing up files... ", "Cancel", 0 )
  134. --- RECORDSEPARATOR ---
  135.  
  136. --- RECORDSEPARATOR ---
  137. Notes:
  138. --- RECORDSEPARATOR ---
  139.  
  140. --- RECORDSEPARATOR ---
  141. By default, this function will not overwrite an existing file if that file is marked as 
  142. --- RECORDSEPARATOR ---
  143. read-only. However, on Windows, by adding 
  144. --- RECORDSEPARATOR ---
  145. "
  146. --- RECORDSEPARATOR ---
  147. +
  148. --- RECORDSEPARATOR ---
  149. " 
  150. --- RECORDSEPARATOR ---
  151. to the 
  152. --- RECORDSEPARATOR ---
  153. "
  154. --- RECORDSEPARATOR ---
  155. Always
  156. --- RECORDSEPARATOR ---
  157. " 
  158. --- RECORDSEPARATOR ---
  159. and 
  160. --- RECORDSEPARATOR ---
  161. "
  162. --- RECORDSEPARATOR ---
  163. IfNewer
  164. --- RECORDSEPARATOR ---
  165. " 
  166. --- RECORDSEPARATOR ---
  167. options (eg "Always+" or "IfNewer+"), the destination files will be overwritten if they 
  168. --- RECORDSEPARATOR ---
  169. are read-only. 
  170. --- RECORDSEPARATOR ---
  171. The return value will not be 0 if any file is not copied. For example, if you specify 
  172. --- RECORDSEPARATOR ---
  173. baXCopyProgress( "c:\data" , "d:\backup" , "*.*" , "IfNewer", ....... ) 
  174. --- RECORDSEPARATOR ---
  175. and any of the files in c:\data are newer than the ones in d:\backup, the return 
  176. --- RECORDSEPARATOR ---
  177. result will be 7 (Dest file is newer than Source). A result of 0 will be returned only if 
  178. --- RECORDSEPARATOR ---
  179. none of the files in c:\data is newer than d:\backup. 
  180. --- RECORDSEPARATOR ---
  181. A return value of 6 (Dest file exists) can only be returned when Overwrite is 
  182. --- RECORDSEPARATOR ---
  183. "IfNotExist".
  184. --- RECORDSEPARATOR ---
  185.  
  186. --- RECORDSEPARATOR ---
  187. (continued next page)